Transforms forRWBean


RWFlashTransform

Formal Parameter Type Default Required Description
RWDZStyleName STRING   false Indicates the style name of the Drop Zone Editor
appliesTo STRING   false

This parameter informs the javascript the id of the bone the actions of this component applies to. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

Possible values for this property are bone ids, its usage depends on the page.
containerHeight STRING -1 false Specifies the height (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerHeight" and this will overwrite the existing value.
containerWidth STRING -1 false Specifies the width (in any measure accepted by the web-browser) of the element rendered by this transform. Its value can be specified on the request as "containerWidth" and this will overwrite the existing value.
contextMenus STRING   false

This formal parameter is used by the Transform to identify the context-menus definition. The value of this parameter can specify either:

  1. The name of a <menu> defined in the pageConfig
  2. The path of an xml file with the context-menu definition

In both cases the xml defines the context-menus using <shortcut-list-set> tags. A <shortcut-list-set> represents a collection of <shortcut-list> tags. Each <shortcut-list> represents a single context-menu. Each <shortcut> represents a single option. Users can add/remove/modify <shortcut> to control the options displayed to the end user.
cssFile STRING   false CSS file that includes the style definition.
If defined, this file will be included as Link.
cssPrefix STRING   false Prefix to append to all css class names.
customJavaScriptFeatures STRING   false Indicates a comma separated list of the extra features that will be send down to the client
debugErrorFlags INTEGER 65535 false Indicates which extra debug information to include in case of an error.
The flags are taken from the EnumWebAppDebugFlags enumeration.
debugFlags INTEGER 0 false Indicates which debug information to include.
The flags are taken from the EnumWebAppDebugFlags enumeration.
documentXMLPageName STRING rwSimple false The name of the page on the pageConfig that returns the custom document XML.
Used to generate the URL for the custom document XML. Allowed values: String value that corresponds to a page name on the pageConfig.
documentXMLStyle STRING RWDataVisualizationXMLStyle false The name of the style to use to generate the custom document XML Allowed values: String value that corresponds to a style on the styleCatalog.
dpiConversion INTEGER 96 false name for the formal parameter "dpiConversion".
dragMode INTEGER 0 false Indicates the drag mode that the component to render will have.
Usage:
This tells us if the dialog can be dragged or docked (or both). Possible values for this property and their meaning include:
  • 1 = can be dragged freely (floating)
  • 2 = can be docked
  • 3 = 1 + 2 (can be dragged freely & docked)
    		•
    extraFlashVars STRING   false The value of this parameter specifies a collection of extra flashVar variables that will be passed to the embedded flash object. These variables consist of name/value pairs in the following format:
    "name1=value1&name2=value2&name3=value3"
    If set through the styleCatalog.xml, the '&' must be encoded, so it should be "name1=value1&amp;name2=value2&amp;name3=value3"
    extraInput STRING   false Indicates any extra inputs to be included in the forms generated by the transform.
    extraUrl STRING   false Indicates any extra parameters to be included in the links generated by the transform.
    flashFile STRING   false The name of the flash SWF file to include. Allowed values: String values
    globalCssErrorMessage STRING error-message false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all error messages.
    globalCssErrorTitle STRING error-title false

    Deprecated. The css class to use for the title cannot be controlled by a Formal Parameter anymore.


    CSS to be used in all Error titles.
    graphTemplatesDesignStyle STRING   false  
    graphTemplatesStyle STRING   false Indicates the graph style to use when rendering GridGraph objects.
    gridDensity INTEGER 1 false name for the formal parameter "gridDensity".
    gridTemplatesDesignStyle STRING   false Indicates the grid style to use when rendering Grid objects in design mode when the RW document is in view mode. This will be used when the RW document is in view mode and the user decides to add a grid object to the RW document. In this case we will render the grid in design mode with no data unless we go back to the server to get the data.
    gridTemplatesStyle STRING   false Indicates the grid style to use when rendering Grid objects.
    height STRING   false Indicates the default height of the component. If this is not a resizable component, this is the height used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.
    iframeEnabled BOOLEAN false false Indicates whether the transform supports iframe manipulations.
    imgCollapse STRING treeCollapse.gif false Specifies the image file name used by the transform to display a collapsable section.
    It is used to collapse the contents of the section when its children are displayed.
    This image should be contained in the images folder of the application.
    Usage:
    For example, if you want to specify a different image to display the collapsable section, you would need to copy it to the images folder and then specify its name in this formal parameter.
    imgExpand STRING treeExpand.gif false Specifies the image file name used by the transform to display an expandable section.
    It is used to expand the contents of the section by showing its children.
    This image should be contained in the images folder of the application.
    Usage:
    For example, if you want to specify a different image to display the expandable section, you would need to copy it to the images folder and then specify its name in this formal parameter.
    imgWait STRING ani_wait.gif false

    Deprecated. This value is not used anymore by the Transform as the wait image is included using css.


    Name of the image for the Processing icon on the Wait page.
    Allowed Values:
    The value to indicate should be a valid image file name, with any necessary path information not included already on the resourcesFolderImage application configuration parameter.
    includeBaseURL BOOLEAN false false Adds a FlashVar named "baseURL" that contains a URL that can be used to access MicroStrategy Web from Flash.
    This link includes the session manager state which is used to restore the session
    initialIndent INTEGER 0 false

    Deprecated. Indentation is not appended by Transforms anymore.


    Indicates the initial indentation of the HTML generated.
    isHTMLExport BOOLEAN false false  
    isViewModeOnly BOOLEAN false false Indicates the only available mode for the document will be HTML view mode.
    jsPrefix STRING   false Prefix to append to all javascript object's ids.
    marqueeSelectionStyle STRING 0 false name for the formal parameter "gridDensity".
    orientation INTEGER 2 false Indicates the orientation the dialog to render will have.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = not docked
  • 1 = docked horizontally
  • 2 = docked vertically
    		•
    orientationsAllowed INTEGER 3 false Indicates the orientation modes allowed for the dialog to render.
    Usage:
    Possible values for this property and their meaning include:
  • 0 = no orientations allowed
  • 1 = horizontal orientation allowed
  • 2 = vertical orientation allowed
  • 3 = 1 + 2 (both horiz & vert orientations are allowed)
    		•
    outlineGridTemplatesStyle STRING   false Indicates the graph style to use when rendering Grid objects in outline mode.
    promptsEditStyle STRING   false This is the name of the style to use to transform a prompted grid when editing reports.
    Allowed Values: any report style name from StyelCatalog.xml file.
    promptsExecuteStyle STRING   false This is the name of the style to use to transform a prompted grid when normal report execution.
    Allowed Values: any report style name from StyelCatalog.xml file.
    resizeLevel INTEGER 0 false Indicates whether the component can be resized vertically/horizontally or both or none. Possible values are AbstractAppTransform.RESIZE_NONE, AbstractAppTransform.RESIZE_VERTICAL, AbstractAppTransform.RESIZE_HORIZONTAL, AbstractAppTransform.RESIZE_ALL
    scriptClass STRING   false Holds the name of the javaScript class (if any) to be associated with the component. When the scriptClass is specified, a bone is registered on the page for this component. A bone is the corresponding concept of a bean in Microstrategy's javascript environment.
    By default, thie methods returns an empty string. Transform which does have an associated bone needs to override this method.
    type STRING   false

    This parameter is used when the output of this Transform generates a corresponding Microstrategy bone in the page, and it informs the javascript the type of bone it is. For example, action of a Toolbar will be applied to the "grid" bone (in the Report page), or the the rwb_viewer (in the document's page).

    Possible values for this property are bone ids, its usage depends on the page.
    units INTEGER 0 false name for the formal parameter "units".
    useAbsoluteURLs BOOLEAN true false Whether to use an absolute path on the CustomURL FlashVar
    useClientSideManipulations BOOLEAN true false name for the formal parameter "useClientSideManipulations".
    useDHTML BOOLEAN true false Indicates whether to use DHTML on the output.
    If not set, the bean's OutputFormat() method will be used.
    width STRING   false Indicates the default width of the component. If this is not a resizable component, this is the width used. If if it resizable, though, the user might change its width using javascript and the value is saved in a preference; thereafter the Transform will use this new value for this component.